Skip to main content

Improvements to accounts GraphQL API

The accounts GraphQL API query and the Account object now offer new fields and options, as described below.

The accounts query now supports a number of filters that can be used to refine the results of a search. These filters include:

  • searchText–Searches through different text fields, including contactEmail and accountName.
  • accountStatus–Returns accounts with the specified status (DISABLED, ENABLED, ENABLED_WITHOUT_LOGIN, PENDING_ACTIVATION).
  • createdBefore–Returns accounts created before a specified date.
  • createdAfter–Returns accounts created after a specified date.
  • accessType– Returns accounts of the specified AccountAccessType (VENDOR, RESELLER, CHANNEL_ADMIN, and so on).

The AccountAccessType now includes two new values:

  • NON_CHANNEL_ADMIN
  • NON_VENDOR

The accounts orderBy field now lets you specify DATE as well as the NAME.

The Account object now includes an accountMembership subquery that returns the memberships associated with the Account. This subquery can filter on a name, and returns a pages response of AccountMemberships

Feature enablement

No feature enablement is required.

Setting enablement

No setting configuration is required.

Documentation

The GraphQL API reference documentation will be updated with the release.

The GraphQL user documentation will be updated with a future release.

Was this page helpful?